Skip to content

Add tested user documentation site and GitHub Pages deployment#26

Merged
vitormattos merged 31 commits into
mainfrom
docs/github-pages-documentation
Jun 1, 2026
Merged

Add tested user documentation site and GitHub Pages deployment#26
vitormattos merged 31 commits into
mainfrom
docs/github-pages-documentation

Conversation

@vitormattos
Copy link
Copy Markdown
Member

@vitormattos vitormattos commented Jun 1, 2026

Summary

This PR now follows the minimal maintenance approach:

  • keep onboarding/documentation in README.md
  • keep runnable examples under examples/
  • keep automated example validation via PHPUnit (tests/Documentation/ExamplesTest.php)
  • remove MkDocs/GitHub Pages/Python documentation stack

What changed (minimal mode)

Kept

  • README.md as the primary user entry point
  • examples/* and examples/assets/*
  • tests/Documentation/ExamplesTest.php
  • PHPUnit documentation testsuite (for example checks)

Removed

  • MkDocs configuration and dependencies:
    • mkdocs.yml
    • requirements-docs.txt
  • docs site source tree:
    • docs/
  • docs drift script:
    • scripts/check-docs-drift.php
  • docs deployment workflow:
    • .github/workflows/docs.yml

Composer scripts

Removed docs-stack scripts and kept example-test script:

  • removed: docs:check-drift, docs:build, docs:serve, docs:test
  • kept equivalent validation intent through: examples:test

Validation executed

  • docker compose run --rm php bash -lc "composer run examples:test"
  • docker compose run --rm php bash -lc "composer validate --strict"

Notes

This update is intentionally pragmatic to reduce long-term maintenance overhead while preserving executable, tested usage examples.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
- Adjust GovBR layout dimensions from 190px to 210px height for better spacing
- Fine-tune typography: font sizes, colors (#666666 for labels, #000000 for name)
- Improve padding/margins distribution (18px vertical, 20px horizontal)
- Increase logo section width proportion (30% → 28%) and metadata width (70% → 72%)
- Adjust line-height and margins between text elements for official alignment
- Regenerate example artifacts with new dimensions and styling

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos vitormattos merged commit 673f75d into main Jun 1, 2026
24 checks passed
@vitormattos vitormattos deleted the docs/github-pages-documentation branch June 1, 2026 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant